home *** CD-ROM | disk | FTP | other *** search
/ IRIX Base Documentation 2002 November / SGI IRIX Base Documentation 2002 November.iso / usr / share / catman / p_man / cat3 / ifl / iflFIT.z / iflFIT
Encoding:
Text File  |  2002-10-03  |  5.6 KB  |  133 lines
  1.  
  2.  
  3.  
  4. iiiiffffllllFFFFIIIITTTT((((3333))))         IIIImmmmaaaaggggeeee FFFFoooorrrrmmmmaaaatttt LLLLiiiibbbbrrrraaaarrrryyyy CCCC++++++++ RRRReeeeffffeeeerrrreeeennnncccceeee MMMMaaaannnnuuuuaaaallll          iiiiffffllllFFFFIIIITTTT((((3333))))
  5.  
  6.  
  7.  
  8. NNNNAAAAMMMMEEEE
  9.      iiiiffffllllFFFFIIIITTTT - FIT file format
  10.  
  11. HHHHEEEEAAAADDDDEEEERRRR FFFFIIIILLLLEEEE
  12.      #include <ifl/iflFIT.h>
  13.  
  14. DDDDEEEESSSSCCCCRRRRIIIIPPPPTTTTIIIIOOOONNNN
  15.      This FIT image file format is an SGI internally-developed format, it was
  16.      primarly intended as a programming example, but like most image formats
  17.      has taken on a life of its own.
  18.  
  19.      The FIT format supports the full flexibility of the IFL model: all data
  20.      types, color models, orders, orientations and page sizes are supported.
  21.      The FIT format can be especially useful with mutli-spectral imagery with
  22.      large number of channels as it supports paging in the channel dimension.
  23.      It can also be a handy format for storing volume data.  Like all file
  24.      formats supported by IFL you access FIT images via the generic object
  25.      class (or the ilFileImg object for IL users).
  26.  
  27.      The default extension for image files in the FIT format is '.fit'.  When
  28.      you create a file with that extension IFL will assume you want the FIT
  29.      format, unless you override it with the iflFormat parameter.
  30.  
  31.      In addition to all the standard iflFile methods, this format supprts an
  32.      number of format specific operations via the ggggeeeettttIIIItttteeeemmmm() and sssseeeettttIIIItttteeeemmmm()
  33.      methods.  The tag values supported by theses methods are enumerated in
  34.      the following sections.
  35.  
  36. TTTTAAAAGGGG VVVVAAAALLLLUUUUEEEESSSS FFFFOOOORRRR GGGGEEEETTTT IIIITTTTEEEEMMMM
  37.      The followng tag values are supported with ggggeeeettttIIIItttteeeemmmm():
  38.  
  39.    iiiiffffllllFFFFIIIITTTTeeeexxxxtttteeeennnnssssiiiioooonnnnSSSSiiiizzzzeeee
  40.           iflStatus getItem(iiiiffffllllFFFFIIIITTTTeeeexxxxtttteeeennnnssssiiiioooonnnnSSSSiiiizzzzeeee, int* extSize)
  41.  
  42.  
  43.      This function returns the size in bytes of the user-extension data area
  44.      in _e_x_t_S_i_z_e.
  45.  
  46.    iiiiffffllllFFFFIIIITTTTeeeexxxxtttteeeennnnssssiiiioooonnnnDDDDaaaattttaaaa
  47.           iflStatus getItem(iiiiffffllllFFFFIIIITTTTeeeexxxxtttteeeennnnssssiiiioooonnnnDDDDaaaattttaaaa, void* extData, int length)
  48.  
  49.  
  50.      This function is used to read _l_e_n_g_t_h bytes of _e_x_t_D_a_t_a from the user-
  51.      extension portion of the FIT file. This tag is also supported with
  52.      sssseeeettttIIIItttteeeemmmm().
  53.  
  54. TTTTAAAAGGGG VVVVAAAALLLLUUUUEEEESSSS FFFFOOOORRRR SSSSEEEETTTT IIIITTTTEEEEMMMM
  55.      The followng tag values are supported with sssseeeettttIIIItttteeeemmmm():
  56.  
  57.    iiiiffffllllFFFFIIIITTTTeeeexxxxtttteeeennnnssssiiiioooonnnnSSSSiiiizzzzeeee
  58.  
  59.  
  60.  
  61.  
  62.  
  63.                                                                         PPPPaaaaggggeeee 1111
  64.  
  65.  
  66.  
  67.  
  68.  
  69.  
  70. iiiiffffllllFFFFIIIITTTT((((3333))))         IIIImmmmaaaaggggeeee FFFFoooorrrrmmmmaaaatttt LLLLiiiibbbbrrrraaaarrrryyyy CCCC++++++++ RRRReeeeffffeeeerrrreeeennnncccceeee MMMMaaaannnnuuuuaaaallll          iiiiffffllllFFFFIIIITTTT((((3333))))
  71.  
  72.  
  73.  
  74.           iflStatus setItem(iiiiffffllllFFFFIIIITTTTeeeexxxxtttteeeennnnssssiiiioooonnnnSSSSiiiizzzzeeee, int extSize)
  75.  
  76.  
  77.      This function can be called before any data is written to a newly-created
  78.      FIT file. Calling the function will reserve _e_x_t_S_i_z_e bytes of space for
  79.      user extensions to the file format. This reserved area can then be
  80.      accessed using ggggeeeettttIIIItttteeeemmmm(((()))) and sssseeeettttIIIItttteeeemmmm(((()))) with the _i_f_l_F_I_T_e_x_t_e_n_s_i_o_n_D_a_t_a tag
  81.      value.
  82.  
  83.    iiiiffffllllFFFFIIIITTTTeeeexxxxtttteeeennnnssssiiiioooonnnnDDDDaaaattttaaaa
  84.           iflStatus setItem(iiiiffffllllFFFFIIIITTTTeeeexxxxtttteeeennnnssssiiiioooonnnnDDDDaaaattttaaaa,,,, vvvvooooiiiidddd**** eeeexxxxttttDDDDaaaattttaaaa,,,, iiiinnnntttt lllleeeennnnggggtttthhhh))))
  85.  
  86.  
  87.      This function is used to write _l_e_n_g_t_h bytes of _e_x_t_D_a_t_a to the user
  88.      extension portion of the FIT file.  Space must be either be reserved
  89.      first with the _i_f_l_F_I_T_e_x_t_e_n_s_i_o_n_S_i_z_e tag or the extension data must be
  90.      written before and image data is written to the file.
  91.  
  92. SSSSEEEEEEEE AAAALLLLSSSSOOOO
  93.      iflFile, ilFileImg
  94.  
  95.  
  96.  
  97.  
  98.  
  99.  
  100.  
  101.  
  102.  
  103.  
  104.  
  105.  
  106.  
  107.  
  108.  
  109.  
  110.  
  111.  
  112.  
  113.  
  114.  
  115.  
  116.  
  117.  
  118.  
  119.  
  120.  
  121.  
  122.  
  123.  
  124.  
  125.  
  126.  
  127.  
  128.  
  129.                                                                         PPPPaaaaggggeeee 2222
  130.  
  131.  
  132.  
  133.